.nh
.TH "NBFC" "1" "MAY 2025" "Notebook FanControl @VERSION@"
.SH NAME
.PP
nbfc \- Notebook FanControl client

.SH DESCRIPTION
.PP
This program is used to control the NoteBook FanControl service.

.SH SYNOPSIS
.PP
.B nbfc
.RB { start " | " stop " | " restart " | " status " | " config " | "  set " | "  update " | " help }
.RI [ OPTIONS ]

.SH OPTIONS
.PP
.BR \-h ", " \-\-help
.RS
Show this help message and exit.
.RE

.PP
.B \-\-version
.RS
Show program's version number and exit.
.RE

.SH COMMANDS
.PP

.B start
.RI [ OPTIONS ]
.RS
Start the service.

.BR \-r ", " \-\-read\-only
.RS
Start in read\-only mode.
.RE
.RE

.B stop
.RI [ OPTIONS ]
.RS
Stop the service.
.RE

.B restart
.RI [ OPTIONS ]
.RS
Restart the service.

.BR \-r ", " \-\-read\-only
.RS
Start in read\-only mode.
.RE
.RE

.B status
.RI [ OPTIONS ]
.RS
Show the service status.

.BR \-a ", " \-\-all
.RS
Show service and fan status (default).
.RE

.BR \-s ", " \-\-service
.RS
Show service status.
.RE

.BR \-f ", " \-\-fan
.I FAN INDEX
.RS
Show fan status.
.RE

.BR \-w ", " \-\-watch
.I SECONDS
.RS
Show status periodically.
.RE
.RE

.B config
.RI [ OPTIONS ]
.RS
List or apply configs.

.BR \-l ", " \-\-list
.RS
List all available configs (default).
.RE

.BR \-r ", " \-\-recommend
.RS
List configs which may work for your device.
.RE

.BR \-s ", " \-\-set
.I CONFIG
.RS
Set a config.
.RE

.BR \-a ", " \-\-apply
.I CONFIG
.RS
Set a config and enable fan control.
.RE
.RE

.B set
.RI [ OPTIONS ]
.RS
Control fan speed.

.BR \-a ", " \-\-auto
.RS
Set fan speed to 'auto'.
.RE

.BR \-s ", " \-\-speed
.I PERCENT
.RS
Set fan speed to PERCENT.
.RE

.BR \-f ", " \-\-fan
.I FAN INDEX
.RS
Fan index (zero based). If not given, all available fans are set to speed.
.RE
.RE

.B update
.RI [ OPTIONS ]
.RS
Download new configuration files.

.BR \-p ", " \-\-parallel
.I NUM
.RS
Set the number of parallel downloads.
.RE

.BR \-q ", " \-\-quiet
.RS
Set quiet mode.
.RE
.RE

.B help
.RS
Show help.
.RE

.SH FILES
.PP

.I @SYSCONFDIR@/nbfc.json
.RS
The main configuration file for nbfc_service. See
.BR nbfc_service.json (5)
for further details.
.RE

.I @RUNSTATEDIR@/nbfc_service.pid
.RS
File containing the PID of current running nbfc_service.
.RE

.I @RUNSTATEDIR@/nbfc_service.socket
.RS
Socket file of nbfc_service.
.RE

.I @DATADIR@/nbfc/configs/*.json
.RS
Configuration files for various notebook models. See
.BR nbfc_service.json (5)
for further details.
.RE

.I @DATADIR@/nbfc/model_support.json
.RS
Model support database. This file maps notebook model names to configuration files.
.RE

.I /var/lib/nbfc/configs/*.json
.RS
Configuration files downloaded from the internet. Files in this directory take precedence over those in
.IR @DATADIR@/nbfc/configs .
.RE

.I /var/lib/nbfc/model_support.json
.RS
Model support database downloaded from the internet. Both
.I /var/lib/nbfc/model_support.json
and
.I @DATADIR@/nbfc/model_support.json
are taken into account.
.RE

.I /var/lib/nbfc/state.json
.RS
State file of nbfc_service. This holds the current fan speeds.
.RE

.SH BUGS
.PP
Report bugs to https://github.com/nbfc\-/nbfc\-linux

.SH AUTHOR
.PP
Benjamin Abendroth (braph93@gmx.de)

.SH SEE ALSO
.PP
.BR nbfc_service (1),
.BR nbfc_service.json (5),
.BR ec_probe (1),
.BR fancontrol (1)
